What is typpy?
Typpy is a lightweight utility for checking JavaScript types. It provides a simple and consistent API to determine the type of a given value, making it easier to handle type checking in your code.
What are typpy's main functionalities?
Type Checking
Typpy allows you to check the type of a given value. It returns a string representing the type, such as 'number', 'string', 'object', 'array', 'null', 'undefined', or 'function'.
const typpy = require('typpy');
console.log(typpy(42)); // 'number'
console.log(typpy('Hello')); // 'string'
console.log(typpy({})); // 'object'
console.log(typpy([])); // 'array'
console.log(typpy(null)); // 'null'
console.log(typpy(undefined)); // 'undefined'
console.log(typpy(() => {})); // 'function'
Type Comparison
Typpy provides a method to compare a value against a specified type. It returns true if the value matches the type, and false otherwise.
const typpy = require('typpy');
console.log(typpy.is(42, 'number')); // true
console.log(typpy.is('Hello', 'string')); // true
console.log(typpy.is({}, 'object')); // true
console.log(typpy.is([], 'array')); // true
console.log(typpy.is(null, 'null')); // true
console.log(typpy.is(undefined, 'undefined')); // true
console.log(typpy.is(() => {}, 'function')); // true
Custom Type Checking
Typpy can also handle custom types. When you create an instance of a custom class, Typpy will return the class name as the type.
const typpy = require('typpy');
class CustomType {}
const customInstance = new CustomType();
console.log(typpy(customInstance)); // 'customtype'
console.log(typpy.is(customInstance, 'customtype')); // true
Other packages similar to typpy
typeof
The 'typeof' package provides a simple way to get the type of a value. It is similar to Typpy but offers a more minimalistic approach. Unlike Typpy, it does not support custom type checking.
type-detect
The 'type-detect' package is another utility for type checking in JavaScript. It offers more detailed type detection compared to Typpy, including support for detecting specific object types like 'RegExp' and 'Date'.
is
The 'is' package provides a comprehensive set of type-checking functions. It is more feature-rich compared to Typpy, offering additional checks for types like 'boolean', 'error', and 'buffer'.
typpy
A better typeof for JavaScript.
:cloud: Installation
npm install --save typpy
yarn add typpy
:clipboard: Example
var Typpy = require("typpy");
console.log(Typpy(0));
console.log(Typpy("", String));
console.log(Typpy.is(null, "null"));
console.log(Typpy.get([]));
console.log(Typpy({}, true));
console.log(Typpy({}, Object));
console.log(Typpy.get({}));
console.log(Typpy.get(42, true));
:question: Get Help
There are few ways to get help:
- Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
- For bug reports and feature requests, open issues. :bug:
- For direct and quick help, you can use Codementor. :rocket:
:memo: Documentation
Typpy(input, target)
Gets the type of the input value or compares it
with a provided type.
Usage:
Typpy({})
Typpy(42, Number);
Typpy.get([], "array"); => true
Params
- Anything
input
: The input value. - Constructor|String
target
: The target type. It could be a string (e.g. "array"
) or a
constructor (e.g. Array
).
Return
- String|Boolean It returns
true
if the input has the provided type target
(if was provided),
false
if the input type does not have the provided type
target
or the stringified type of the input (always lowercase).
Typpy.is(input, target)
Checks if the input value has a specified type.
Params
- Anything
input
: The input value. - Constructor|String
target
: The target type. It could be a string (e.g. "array"
) or a
constructor (e.g. Array
).
Return
- Boolean
true
, if the input has the same type with the target or false
otherwise.
Typpy.get(input, str)
Gets the type of the input value. This is used internally.
Params
- Anything
input
: The input value. - Boolean
str
: A flag to indicate if the return value should be a string or not.
Return
- Constructor|String The input value constructor (if any) or the stringified type (always lowercase).
:yum: How to contribute
Have an idea? Found a bug? See how to contribute.
:sparkling_heart: Support my projects
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).
However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
-
Starring and sharing the projects you like :rocket:
-
—I love books! I will remember you after years if you buy me one. :grin: :book:
-
—You can make one-time donations via PayPal. I'll probably buy a coffee tea. :tea:
-
—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
-
Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6
Thanks! :heart:
:dizzy: Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles:
ul
scrape-it
err
bug-killer
tilda
deffy
couleurs
auto-parse
barbe
elm-select
exec-limiter
color-it
diable
write-file-p
obj-flatten
cli-gh-cal
cute-logger
bloggify-ajs-renderer
page-changed
transformer
bloggify-flexible-router
bloggify-renderer-ajs
git-stats
engine-parser
engine-builder
enny
engine-flow-types
gh-repos
ghcal
ghosty
asyncer.js
babel-it
blah
cli-circle
validify
limit-it
obj2env
lynn-touch
scrape-it-plus
@slikts/scrape-it
dom-repeater
animato
git-stats-importer
regarde
flattenize
:scroll: License
MIT © Ionică Bizău